<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>colorizer Docs</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>colorizer</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
<li><a href="#Fields">Fields</a></li>
</ul>


<h2>Modules</h2>
<ul class="nowrap">
  <li><a href="../modules/colorizer.html">colorizer</a></li>
  <li><strong>buffer</strong></li>
  <li><a href="../modules/colorizer.color.html">color</a></li>
  <li><a href="../modules/colorizer.matcher.html">matcher</a></li>
  <li><a href="../modules/colorizer.parser.argb_hex.html">parser.argb_hex</a></li>
  <li><a href="../modules/colorizer.parser.hsl.html">parser.hsl</a></li>
  <li><a href="../modules/colorizer.parser.names.html">parser.names</a></li>
  <li><a href="../modules/colorizer.parser.rgb.html">parser.rgb</a></li>
  <li><a href="../modules/colorizer.parser.rgba_hex.html">parser.rgba_hex</a></li>
  <li><a href="../modules/colorizer.sass.html">sass</a></li>
  <li><a href="../modules/colorizer.tailwind.html">tailwind</a></li>
  <li><a href="../modules/colorizer.trie.html">trie</a></li>
  <li><a href="../modules/colorizer.utils.html">utils</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>colorizer.buffer</code></h1>
<p>Helper functions to highlight buffer smartly</p>
<p>

</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#clear_hl_cache">clear_hl_cache ()</a></td>
	<td class="summary">Clean the highlight cache</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#add_highlight">add_highlight (buf, ns, line_start, line_end, data, options)</a></td>
	<td class="summary">Create highlight and set highlights</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#highlight">highlight (buf, ns, line_start, line_end, options, options_local)</a></td>
	<td class="summary">Highlight the buffer region.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#parse_lines">parse_lines (buf, lines, line_start, options)</a></td>
	<td class="summary">Parse the given lines for colors and return a table containing
 rgb_hex and range per line</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#rehighlight">rehighlight (buf, options, options_local, use_local_lines)</a></td>
	<td class="summary">Rehighlight the buffer if colorizer is active</td>
	</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#highlight_mode_names">highlight_mode_names</a></td>
	<td class="summary">Highlight mode which will be use to render the colour</td>
	</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#default_namespace">default_namespace</a></td>
	<td class="summary">Default namespace used in <a href="../modules/colorizer.buffer.html#highlight">highlight</a> and <a href="../modules/colorizer.html#attach_to_buffer">colorizer.attach_to_buffer</a>.</td>
	</tr>
</table>

<br/>
<br/>


    <h2 class="section-header "><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "clear_hl_cache"></a>
    <strong>clear_hl_cache ()</strong>
    </dt>
    <dd>
    Clean the highlight cache







</dd>
    <dt>
    <a name = "add_highlight"></a>
    <strong>add_highlight (buf, ns, line_start, line_end, data, options)</strong>
    </dt>
    <dd>
    Create highlight and set highlights


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">buf</span>
         number
        </li>
        <li><span class="parameter">ns</span>
         number
        </li>
        <li><span class="parameter">line_start</span>
         number
        </li>
        <li><span class="parameter">line_end</span>
         number
        </li>
        <li><span class="parameter">data</span>
         table: table output of <a href="../modules/colorizer.buffer.html#parse_lines">parse_lines</a>
        </li>
        <li><span class="parameter">options</span>
         table: Passed in setup, mainly for <code>user_default_options</code>
        </li>
    </ul>





</dd>
    <dt>
    <a name = "highlight"></a>
    <strong>highlight (buf, ns, line_start, line_end, options, options_local)</strong>
    </dt>
    <dd>
    Highlight the buffer region.
 Highlight starting from <code>line_start</code> (0-indexed) for each line described by <code>lines</code> in the
 buffer <code>buf</code> and attach it to the namespace <code>ns</code>.


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">buf</span>
         number: buffer id
        </li>
        <li><span class="parameter">ns</span>
         number: The namespace id. Default is DEFAULT_NAMESPACE. Create it with <code>vim.api.nvim_create_namespace</code>
        </li>
        <li><span class="parameter">line_start</span>
         number: line_start should be 0-indexed
        </li>
        <li><span class="parameter">line_end</span>
         number: Last line to highlight
        </li>
        <li><span class="parameter">options</span>
         table: Configuration options as described in <code>setup</code>
        </li>
        <li><span class="parameter">options_local</span>
         table: Buffer local variables
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        nil|boolean|number,table
    </ol>




</dd>
    <dt>
    <a name = "parse_lines"></a>
    <strong>parse_lines (buf, lines, line_start, options)</strong>
    </dt>
    <dd>
    Parse the given lines for colors and return a table containing
 rgb_hex and range per line


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">buf</span>
         number
        </li>
        <li><span class="parameter">lines</span>
         table
        </li>
        <li><span class="parameter">line_start</span>
         number: This is the buffer line number, from where to start highlighting
        </li>
        <li><span class="parameter">options</span>
         table: Passed in <a href="../modules/colorizer.html#setup">colorizer.setup</a>, Only uses <code>user_default_options</code>
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        table|nil
    </ol>




</dd>
    <dt>
    <a name = "rehighlight"></a>
    <strong>rehighlight (buf, options, options_local, use_local_lines)</strong>
    </dt>
    <dd>
    Rehighlight the buffer if colorizer is active


    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">buf</span>
         number: Buffer number
        </li>
        <li><span class="parameter">options</span>
         table: Buffer options
        </li>
        <li><span class="parameter">options_local</span>
         table|nil: Buffer local variables
        </li>
        <li><span class="parameter">use_local_lines</span>
         boolean|nil Whether to use lines num range from options_local
        </li>
    </ul>

    <h3>Returns:</h3>
    <ol>

        nil|boolean|number,table
    </ol>




</dd>
</dl>
    <h2 class="section-header "><a name="Tables"></a>Tables</h2>

    <dl class="function">
    <dt>
    <a name = "highlight_mode_names"></a>
    <strong>highlight_mode_names</strong>
    </dt>
    <dd>
    Highlight mode which will be use to render the colour


    <h3>Fields:</h3>
    <ul>
        <li><span class="parameter">background</span>



        </li>
        <li><span class="parameter">foreground</span>



        </li>
        <li><span class="parameter">virtualtext</span>



        </li>
    </ul>





</dd>
</dl>
    <h2 class="section-header "><a name="Fields"></a>Fields</h2>

    <dl class="function">
    <dt>
    <a name = "default_namespace"></a>
    <strong>default_namespace</strong>
    </dt>
    <dd>
    Default namespace used in <a href="../modules/colorizer.buffer.html#highlight">highlight</a> and <a href="../modules/colorizer.html#attach_to_buffer">colorizer.attach_to_buffer</a>.





    <h3>See also:</h3>
    <ul>
         <li><a href="../modules/colorizer.buffer.html#highlight">highlight</a></li>
         <li><a href="../modules/colorizer.html#attach_to_buffer">colorizer.attach_to_buffer</a></li>
    </ul>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated - February </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
